/*  mbed Microcontroller Library
    Copyright (c) 2006-2013 ARM Limited

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
*/
#ifndef MBED_SLEEP_API_H
#define MBED_SLEEP_API_H

#include "device.h"

#if DEVICE_SLEEP

#ifdef __cplusplus
extern "C" {
#endif

/** Send the microcontroller to sleep

    The processor is setup ready for sleep, and sent to sleep using __WFI(). In this mode, the
    system clock to the core is stopped until a reset or an interrupt occurs. This eliminates
    dynamic power used by the processor, memory systems and buses. The processor, peripheral and
    memory state are maintained, and the peripherals continue to work and can generate interrupts.

    The processor can be woken up by any internal peripheral interrupt or external pin interrupt.

    @note
    The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
    Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
    able to access the LocalFileSystem
*/
void sleep(void);

/** Send the microcontroller to deep sleep

    This processor is setup ready for deep sleep, and sent to sleep using __WFI(). This mode
    has the same sleep features as sleep plus it powers down peripherals and clocks. All state
    is still maintained.

    The processor can only be woken up by an external interrupt on a pin or a watchdog timer.

    @note
    The mbed interface semihosting is disconnected as part of going to sleep, and can not be restored.
    Flash re-programming and the USB serial port will remain active, but the mbed program will no longer be
    able to access the LocalFileSystem
*/
void deepsleep(void);

#ifdef __cplusplus
}
#endif

#endif

#endif
